<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>BaseSingleFieldPeriod xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/goda/time/base/BaseSingleFieldPeriod.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2006 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time.base;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.goda.time.Chronology;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeUtils;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DurationField;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DurationFieldType;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.goda.time.MutablePeriod;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.goda.time.Period;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.goda.time.PeriodType;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.goda.time.ReadableInstant;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.goda.time.ReadablePartial;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.goda.time.ReadablePeriod;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.goda.time.chrono.ISOChronology;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.goda.time.field.FieldUtils;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">/**</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * BaseSingleFieldPeriod is an abstract implementation of ReadablePeriod that</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * manages a single duration field, such as days or minutes.</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * This class should generally not be used directly by API users.</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * The {@link ReadablePeriod} interface should be used when different </em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * kinds of period objects are to be referenced.</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * BaseSingleFieldPeriod subclasses may be mutable and not thread-safe.</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> *</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * @since 1.4</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> */</em>
<a name="46" href="#46">46</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/goda/time/base/BaseSingleFieldPeriod.html">BaseSingleFieldPeriod</a>
<a name="47" href="#47">47</a>          implements ReadablePeriod, Comparable, Serializable {
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Serialization version. */</em>
<a name="50" href="#50">50</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 9386874258972L;
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The period in the units of this period. */</em>
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iPeriod;
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="56" href="#56">56</a>      <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * Calculates the number of whole units between the two specified datetimes.</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     *</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * @param start  the start instant, validated to not be null</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @param end  the end instant, validated to not be null</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * @param field  the field type to use, must not be null</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * @return the period</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the instants are null or invalid</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     */</em>
<a name="65" href="#65">65</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> between(<a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> start, <a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> end, <a href="../../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> field) {
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">if</strong> (start == <strong class="jxr_keyword">null</strong> || end == <strong class="jxr_keyword">null</strong>) {
<a name="67" href="#67">67</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ReadableInstant objects must not be null"</span>);
<a name="68" href="#68">68</a>          }
<a name="69" href="#69">69</a>          <a href="../../../../org/goda/time/Chronology.html">Chronology</a> chrono = DateTimeUtils.getInstantChronology(start);
<a name="70" href="#70">70</a>          <strong class="jxr_keyword">int</strong> amount = field.getField(chrono).getDifference(end.getMillis(), start.getMillis());
<a name="71" href="#71">71</a>          <strong class="jxr_keyword">return</strong> amount;
<a name="72" href="#72">72</a>      }
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="75" href="#75">75</a>      <em class="jxr_javadoccomment">/**</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * Calculates the number of whole units between the two specified partial datetimes.</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * The two partials must contain the same fields, for example you can specify</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * two &lt;code&gt;LocalDate&lt;/code&gt; objects.</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     *</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * @param start  the start partial date, validated to not be null</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * @param end  the end partial date, validated to not be null</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * @param zeroInstance  the zero instance constant, must not be null</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @return the period</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the partials are null or invalid</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     */</em>
<a name="87" href="#87">87</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> between(<a href="../../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> start, <a href="../../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> end, <a href="../../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> zeroInstance) {
<a name="88" href="#88">88</a>          <strong class="jxr_keyword">if</strong> (start == <strong class="jxr_keyword">null</strong> || end == <strong class="jxr_keyword">null</strong>) {
<a name="89" href="#89">89</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ReadablePartial objects must not be null"</span>);
<a name="90" href="#90">90</a>          }
<a name="91" href="#91">91</a>          <strong class="jxr_keyword">if</strong> (start.size() != end.size()) {
<a name="92" href="#92">92</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ReadablePartial objects must have the same set of fields"</span>);
<a name="93" href="#93">93</a>          }
<a name="94" href="#94">94</a>          <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0, isize = start.size(); i &lt; isize; i++) {
<a name="95" href="#95">95</a>              <strong class="jxr_keyword">if</strong> (start.getFieldType(i) != end.getFieldType(i)) {
<a name="96" href="#96">96</a>                  <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ReadablePartial objects must have the same set of fields"</span>);
<a name="97" href="#97">97</a>              }
<a name="98" href="#98">98</a>          }
<a name="99" href="#99">99</a>          <strong class="jxr_keyword">if</strong> (DateTimeUtils.isContiguous(start) == false) {
<a name="100" href="#100">100</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ReadablePartial objects must be contiguous"</span>);
<a name="101" href="#101">101</a>         }
<a name="102" href="#102">102</a>         <a href="../../../../org/goda/time/Chronology.html">Chronology</a> chrono = DateTimeUtils.getChronology(start.getChronology()).withUTC();
<a name="103" href="#103">103</a>         <strong class="jxr_keyword">int</strong>[] values = chrono.get(zeroInstance, chrono.set(start, 0L), chrono.set(end, 0L));
<a name="104" href="#104">104</a>         <strong class="jxr_keyword">return</strong> values[0];
<a name="105" href="#105">105</a>     }
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>     <em class="jxr_javadoccomment">/**</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * Creates a new instance representing the number of complete standard length units</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * in the specified period.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * This factory method converts all fields from the period to hours using standardised</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * durations for each field. Only those fields which have a precise duration in</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * the ISO UTC chronology can be converted.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * &lt;ul&gt;</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * &lt;li&gt;One week consists of 7 days.</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * &lt;li&gt;One day consists of 24 hours.</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * &lt;li&gt;One hour consists of 60 minutes.</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * &lt;li&gt;One minute consists of 60 seconds.</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * &lt;li&gt;One second consists of 1000 milliseconds.</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * &lt;/ul&gt;</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * Months and Years are imprecise and periods containing these values cannot be converted.</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     *</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * @param period  the period to get the number of hours from, must not be null</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * @param millisPerUnit  the number of milliseconds in one standard unit of this period</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the period contains imprecise duration values</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     */</em>
<a name="127" href="#127">127</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> standardPeriodIn(<a href="../../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> period, <strong class="jxr_keyword">long</strong> millisPerUnit) {
<a name="128" href="#128">128</a>         <strong class="jxr_keyword">if</strong> (period == <strong class="jxr_keyword">null</strong>) {
<a name="129" href="#129">129</a>             <strong class="jxr_keyword">return</strong> 0;
<a name="130" href="#130">130</a>         }
<a name="131" href="#131">131</a>         <a href="../../../../org/goda/time/Chronology.html">Chronology</a> iso = ISOChronology.getInstanceUTC();
<a name="132" href="#132">132</a>         <strong class="jxr_keyword">long</strong> duration = 0L;
<a name="133" href="#133">133</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; period.size(); i++) {
<a name="134" href="#134">134</a>             <strong class="jxr_keyword">int</strong> value = period.getValue(i);
<a name="135" href="#135">135</a>             <strong class="jxr_keyword">if</strong> (value != 0) {
<a name="136" href="#136">136</a>                 <a href="../../../../org/goda/time/DurationField.html">DurationField</a> field = period.getFieldType(i).getField(iso);
<a name="137" href="#137">137</a>                 <strong class="jxr_keyword">if</strong> (field.isPrecise() == false) {
<a name="138" href="#138">138</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="139" href="#139">139</a>                             <span class="jxr_string">"Cannot convert period to duration as "</span> + field.getName() +
<a name="140" href="#140">140</a>                             <span class="jxr_string">" is not precise in the period "</span> + period);
<a name="141" href="#141">141</a>                 }
<a name="142" href="#142">142</a>                 duration = FieldUtils.safeAdd(duration, FieldUtils.safeMultiply(field.getUnitMillis(), value));
<a name="143" href="#143">143</a>             }
<a name="144" href="#144">144</a>         }
<a name="145" href="#145">145</a>         <strong class="jxr_keyword">return</strong> FieldUtils.safeToInt(duration / millisPerUnit);
<a name="146" href="#146">146</a>     }
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="149" href="#149">149</a>     <em class="jxr_javadoccomment">/**</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * Creates a new instance representing the specified period.</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     *</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * @param period  the period to represent</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     */</em>
<a name="154" href="#154">154</a>     <strong class="jxr_keyword">protected</strong> <a href="../../../../org/goda/time/base/BaseSingleFieldPeriod.html">BaseSingleFieldPeriod</a>(<strong class="jxr_keyword">int</strong> period) {
<a name="155" href="#155">155</a>         <strong class="jxr_keyword">super</strong>();
<a name="156" href="#156">156</a>         iPeriod = period;
<a name="157" href="#157">157</a>     }
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="160" href="#160">160</a>     <em class="jxr_javadoccomment">/**</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * Gets the amount of this period.</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     *</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @return the period value</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     */</em>
<a name="165" href="#165">165</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getValue() {
<a name="166" href="#166">166</a>         <strong class="jxr_keyword">return</strong> iPeriod;
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em class="jxr_javadoccomment">/**</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * Sets the amount of this period.</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * To make a subclass immutable you must declare it final, or block this method.</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     *</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * @param value  the period value</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     */</em>
<a name="175" href="#175">175</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setValue(<strong class="jxr_keyword">int</strong> value) {
<a name="176" href="#176">176</a>         iPeriod = value;
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="180" href="#180">180</a>     <em class="jxr_javadoccomment">/**</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * Gets the single duration field type.</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     *</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * @return the duration field type, not null</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     */</em>
<a name="185" href="#185">185</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> getFieldType();
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a>     <em class="jxr_javadoccomment">/**</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     * Gets the period type which matches the duration field type.</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment">     *</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     * @return the period type, not null</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">     */</em>
<a name="192" href="#192">192</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../org/goda/time/PeriodType.html">PeriodType</a> getPeriodType();
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="195" href="#195">195</a>     <em class="jxr_javadoccomment">/**</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * Gets the number of fields that this period supports, which is one.</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     *</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * @return the number of fields supported, which is one</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     */</em>
<a name="200" href="#200">200</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> size() {
<a name="201" href="#201">201</a>         <strong class="jxr_keyword">return</strong> 1;
<a name="202" href="#202">202</a>     }
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a>     <em class="jxr_javadoccomment">/**</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * Gets the field type at the specified index.</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="207" href="#207">207</a> <em class="jxr_javadoccomment">     * The only index supported by this period is zero which returns the</em>
<a name="208" href="#208">208</a> <em class="jxr_javadoccomment">     * field type of this class.</em>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment">     *</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     * @param index  the index to retrieve, which must be zero</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     * @return the field at the specified index</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment">     * @throws IndexOutOfBoundsException if the index is invalid</em>
<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">     */</em>
<a name="214" href="#214">214</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> getFieldType(<strong class="jxr_keyword">int</strong> index) {
<a name="215" href="#215">215</a>         <strong class="jxr_keyword">if</strong> (index != 0) {
<a name="216" href="#216">216</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IndexOutOfBoundsException(String.valueOf(index));
<a name="217" href="#217">217</a>         }
<a name="218" href="#218">218</a>         <strong class="jxr_keyword">return</strong> getFieldType();
<a name="219" href="#219">219</a>     }
<a name="220" href="#220">220</a> 
<a name="221" href="#221">221</a>     <em class="jxr_javadoccomment">/**</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * Gets the value at the specified index.</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * The only index supported by this period is zero.</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     *</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * @param index  the index to retrieve, which must be zero</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * @return the value of the field at the specified index</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * @throws IndexOutOfBoundsException if the index is invalid</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     */</em>
<a name="230" href="#230">230</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getValue(<strong class="jxr_keyword">int</strong> index) {
<a name="231" href="#231">231</a>         <strong class="jxr_keyword">if</strong> (index != 0) {
<a name="232" href="#232">232</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IndexOutOfBoundsException(String.valueOf(index));
<a name="233" href="#233">233</a>         }
<a name="234" href="#234">234</a>         <strong class="jxr_keyword">return</strong> getValue();
<a name="235" href="#235">235</a>     }
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>     <em class="jxr_javadoccomment">/**</em>
<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * Gets the value of a duration field represented by this period.</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     * If the field type specified does not match the type used by this class</em>
<a name="241" href="#241">241</a> <em class="jxr_javadoccomment">     * then zero is returned.</em>
<a name="242" href="#242">242</a> <em class="jxr_javadoccomment">     *</em>
<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * @param type  the field type to query, null returns zero</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * @return the value of that field, zero if field not supported</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     */</em>
<a name="246" href="#246">246</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> get(<a href="../../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> type) {
<a name="247" href="#247">247</a>         <strong class="jxr_keyword">if</strong> (type == getFieldType()) {
<a name="248" href="#248">248</a>             <strong class="jxr_keyword">return</strong> getValue();
<a name="249" href="#249">249</a>         }
<a name="250" href="#250">250</a>         <strong class="jxr_keyword">return</strong> 0;
<a name="251" href="#251">251</a>     }
<a name="252" href="#252">252</a> 
<a name="253" href="#253">253</a>     <em class="jxr_javadoccomment">/**</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * Checks whether the duration field specified is supported by this period.</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     *</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     * @param type  the type to check, may be null which returns false</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * @return true if the field is supported</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     */</em>
<a name="259" href="#259">259</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSupported(<a href="../../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> type) {
<a name="260" href="#260">260</a>         <strong class="jxr_keyword">return</strong> (type == getFieldType());
<a name="261" href="#261">261</a>     }
<a name="262" href="#262">262</a> 
<a name="263" href="#263">263</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="264" href="#264">264</a>     <em class="jxr_javadoccomment">/**</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * Get this period as an immutable &lt;code&gt;Period&lt;/code&gt; object.</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * The period will use &lt;code&gt;PeriodType.standard()&lt;/code&gt;.</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     *</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     * @return a &lt;code&gt;Period&lt;/code&gt; representing the same number of days</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     */</em>
<a name="270" href="#270">270</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/Period.html">Period</a> toPeriod() {
<a name="271" href="#271">271</a>         <strong class="jxr_keyword">return</strong> Period.ZERO.withFields(<strong class="jxr_keyword">this</strong>);
<a name="272" href="#272">272</a>     }
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>     <em class="jxr_javadoccomment">/**</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * Get this object as a &lt;code&gt;MutablePeriod&lt;/code&gt;.</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * This will always return a new &lt;code&gt;MutablePeriod&lt;/code&gt; with the same fields.</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * The period will use &lt;code&gt;PeriodType.standard()&lt;/code&gt;.</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * </em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * @return a MutablePeriod using the same field set and values</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">     */</em>
<a name="282" href="#282">282</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/MutablePeriod.html">MutablePeriod</a> toMutablePeriod() {
<a name="283" href="#283">283</a>         <a href="../../../../org/goda/time/MutablePeriod.html">MutablePeriod</a> period = <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/MutablePeriod.html">MutablePeriod</a>();
<a name="284" href="#284">284</a>         period.add(<strong class="jxr_keyword">this</strong>);
<a name="285" href="#285">285</a>         <strong class="jxr_keyword">return</strong> period;
<a name="286" href="#286">286</a>     }
<a name="287" href="#287">287</a> 
<a name="288" href="#288">288</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="289" href="#289">289</a>     <em class="jxr_javadoccomment">/**</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     * Compares this object with the specified object for equality based on the</em>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * value of each field. All ReadablePeriod instances are accepted, but only</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment">     * those with a matching &lt;code&gt;PeriodType&lt;/code&gt; can return true.</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     *</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">     * @param period  a readable period to check against</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment">     * @return true if all the field values are equal, false if</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment">     *  not or the period is null or of an incorrect type</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     */</em>
<a name="298" href="#298">298</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object period) {
<a name="299" href="#299">299</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == period) {
<a name="300" href="#300">300</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="301" href="#301">301</a>         }
<a name="302" href="#302">302</a>         <strong class="jxr_keyword">if</strong> (period instanceof ReadablePeriod == false) {
<a name="303" href="#303">303</a>             <strong class="jxr_keyword">return</strong> false;
<a name="304" href="#304">304</a>         }
<a name="305" href="#305">305</a>         <a href="../../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> other = (ReadablePeriod) period;
<a name="306" href="#306">306</a>         <strong class="jxr_keyword">return</strong> (other.getPeriodType() == getPeriodType() &amp;&amp; other.getValue(0) == getValue());
<a name="307" href="#307">307</a>     }
<a name="308" href="#308">308</a> 
<a name="309" href="#309">309</a>     <em class="jxr_javadoccomment">/**</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * Gets a hash code for the period as defined by ReadablePeriod.</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     *</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">     * @return a hash code</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">     */</em>
<a name="314" href="#314">314</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a name="315" href="#315">315</a>         <strong class="jxr_keyword">int</strong> total = 17;
<a name="316" href="#316">316</a>         total = 27 * total + getValue();
<a name="317" href="#317">317</a>         total = 27 * total + getFieldType().hashCode();
<a name="318" href="#318">318</a>         <strong class="jxr_keyword">return</strong> total;
<a name="319" href="#319">319</a>     }
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a>     <em class="jxr_javadoccomment">/**</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     * Compares this period to another object of the same class.</em>
<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">     *</em>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">     * @param other  the other period, must not be null</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment">     * @return zero if equal, positive if greater, negative if less</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">     * @throws NullPointerException if the other period is null</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">     * @throws ClassCastException if the other period is of a different type</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     */</em>
<a name="329" href="#329">329</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compareTo(Object other) {
<a name="330" href="#330">330</a>         <strong class="jxr_keyword">if</strong> (other.getClass() != getClass()) {
<a name="331" href="#331">331</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ClassCastException(getClass() + <span class="jxr_string">" cannot be compared to "</span> + other.getClass());
<a name="332" href="#332">332</a>         }
<a name="333" href="#333">333</a>         <strong class="jxr_keyword">int</strong> otherValue = ((BaseSingleFieldPeriod) other).getValue();
<a name="334" href="#334">334</a>         <strong class="jxr_keyword">int</strong> thisValue = getValue();
<a name="335" href="#335">335</a>         <strong class="jxr_keyword">if</strong> (thisValue &gt; otherValue) {
<a name="336" href="#336">336</a>             <strong class="jxr_keyword">return</strong> 1;
<a name="337" href="#337">337</a>         }
<a name="338" href="#338">338</a>         <strong class="jxr_keyword">if</strong> (thisValue &lt; otherValue) {
<a name="339" href="#339">339</a>             <strong class="jxr_keyword">return</strong> -1;
<a name="340" href="#340">340</a>         }
<a name="341" href="#341">341</a>         <strong class="jxr_keyword">return</strong> 0;
<a name="342" href="#342">342</a>     }
<a name="343" href="#343">343</a> 
<a name="344" href="#344">344</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

